<html>
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   
      <link rel="stylesheet" href="./../helpwin.css">
      <title>MATLAB File Help: prtRegressRvm</title>
   </head>
   <body>
      <!--Single-page help-->
      <table border="0" cellspacing="0" width="100%">
         <tr class="subheader">
            <td class="headertitle">MATLAB File Help: prtRegressRvm</td>
            
            
         </tr>
      </table>
      <div class="title">prtRegressRvm</div>
      <div class="helptext"><pre><!--helptext -->  <span class="helptopic">prtRegressRvm</span>  Relevance vector machine regression object
 
    REGRESS = <span class="helptopic">prtRegressRvm</span> returns a <span class="helptopic">prtRegressRvm</span> object
 
     REGRESS = prtRegressRVM(PROPERTY1, VALUE1, ...) constructs a
     <span class="helptopic">prtRegressRvm</span> object REGRESS with properties as specified by
     PROPERTY/VALUE pairs.
  
     A <span class="helptopic">prtRegressRvm</span> object inherits all properties from the prtRegress
     class. In addition, it has the following properties:
 
    SetAccess = public:
     kernels            - A cell array of prtKernel objects specifying
                          the kernels to use
     verbosePlot        - Flag indicating whether or not to plot during
                          training
     verboseText        - Flag indicating whether or not to display
                          a message during training
 
    SetAccess = private/protected:
     learningConverged  - Flag indicating if the training converged
     learningResults    - Struct with information about the convergence
     beta               - The weights on each of the kernel elements;
                          learned during training
     Sigma              - The learned covariance
     sparseBeta         - The weights on the retained kernel elements;
                          learned durning training
     sparseKernels      - The retained kernels
 
    This code is based on:
        Michael E Tipping, Sparse bayesian learning and the relevance 
    vector machine, The Journal of Machine Learning Research, Vol 1.
 
    Also see <a href="http://en.wikipedia.org/wiki/Relevance_vector_machine">http://en.wikipedia.org/wiki/Relevance_vector_machine</a>
  
    A prtRegressionRvm object inherits the PLOT method from the
    prtRegress object, and the TRAIN, RUN, CROSSVALIDATE and KFOLDS
    methods from the prtAction object.
 
    Example:
    
    dataSet = prtDataGenNoisySinc;           % Load a prtDataRegress
    dataSet.plot;                    % Display data
    reg = <span class="helptopic">prtRegressRvm</span>;             % Create a <span class="helptopic">prtRegressRvm</span> object
    reg = reg.train(dataSet);        % Train the <span class="helptopic">prtRegressRvm</span> object
    reg.plot();                      % Plot the resulting curve
    dataSetOut = reg.run(dataSet);   % Run the regressor on the data
    hold on;
    plot(dataSet.getX,dataSetOut.getX,'c.') % Plot, overlaying the
                                            % fitted points with the 
                                            % curve and original data
    legend('Regression curve','Original Points','Kernel Locations Used',0)</pre></div><!--after help --><!--seeAlso--><div class="footerlinktitle">See also</div><div class="footerlink"> <a href="./prtRegress.html">prtRegress</a>, <a href="./prtRegressGp.html">prtRegressGp</a>, <a href="./prtRegressLslr.html">prtRegressLslr</a>
</div>
      <!--Class-->
      <div class="sectiontitle">Class Details</div>
      <table class="class-details">
         <tr>
            <td class="class-detail-label">Superclasses</td>
            <td><a href="./prtRegress.html">prtRegress</a></td>
         </tr>
         <tr>
            <td class="class-detail-label">Sealed</td>
            <td>false</td>
         </tr>
         <tr>
            <td class="class-detail-label">Construct on load</td>
            <td>false</td>
         </tr>
      </table>
      <!--Constructors-->
      <div class="sectiontitle"><a name="constructors"></a>Constructor Summary
      </div>
      <table class="summary-list">
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/prtRegressRvm.html">prtRegressRvm</a></td>
            <td class="m-help">Relevance vector machine regression object&nbsp;</td>
         </tr>
      </table>
      <!--Properties-->
      <div class="sectiontitle"><a name="properties"></a>Property Summary
      </div>
      <table class="summary-list">
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/Sigma.html">Sigma</a></td>
            <td class="m-help">Estimated in training&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/beta.html">beta</a></td>
            <td class="m-help">Estimated in training&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/dataSet.html">dataSet</a></td>
            <td class="m-help">The training prtDataSet, only stored if verboseStorage is true. &nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/dataSetSummary.html">dataSetSummary</a></td>
            <td class="m-help">Structure that summarizes prtDataSet.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/isCrossValidateValid.html">isCrossValidateValid</a></td>
            <td class="m-help">True&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/isSupervised.html">isSupervised</a></td>
            <td class="m-help">True&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/isTrained.html">isTrained</a></td>
            <td class="m-help">Indicates if prtAction object has been trained.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/kernels.html">kernels</a></td>
            <td class="m-help">&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/learningConverged.html">learningConverged</a></td>
            <td class="m-help">Whether or not the training converged&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/name.html">name</a></td>
            <td class="m-help">Relevance Vector Machine&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/nameAbbreviation.html">nameAbbreviation</a></td>
            <td class="m-help">RVM&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/plotOptions.html">plotOptions</a></td>
            <td class="m-help">Plotting Options&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/showProgressBar.html">showProgressBar</a></td>
            <td class="m-help">&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/sigma2.html">sigma2</a></td>
            <td class="m-help">Estimated in training&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/sparseBeta.html">sparseBeta</a></td>
            <td class="m-help">Estimated in training&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/sparseKernels.html">sparseKernels</a></td>
            <td class="m-help">Estimated in training &nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/userData.html">userData</a></td>
            <td class="m-help">User specified data&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/verbosePlot.html">verbosePlot</a></td>
            <td class="m-help">Whether or not to plot during training&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/verboseStorage.html">verboseStorage</a></td>
            <td class="m-help">Specifies whether or not to store the training prtDataset.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="name"><a href="./prtRegressRvm/verboseText.html">verboseText</a></td>
            <td class="m-help">Whether or not to plot during training&nbsp;</td>
         </tr>
      </table>
      <!--Methods-->
      <div class="sectiontitle"><a name="methods"></a>Method Summary
      </div>
      <table class="summary-list">
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRegressRvm/crossValidate.html">crossValidate</a></td>
            <td class="m-help">Cross validate prtAction using prtDataSet and cross validation keys.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRegressRvm/get.html">get</a></td>
            <td class="m-help">get the object properties&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRegressRvm/kfolds.html">kfolds</a></td>
            <td class="m-help">Perform K-folds cross-validation of prtAction&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRegressRvm/optimize.html">optimize</a></td>
            <td class="m-help">Optimize action parameter by exhaustive function maximization.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRegressRvm/plot.html">plot</a></td>
            <td class="m-help">Plot the prtRegress object&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRegressRvm/run.html">run</a></td>
            <td class="m-help">Run a prtAction object on a prtDataSet object.&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRegressRvm/runRegressorOnGrid.html">runRegressorOnGrid</a></td>
            <td class="m-help">&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRegressRvm/set.html">set</a></td>
            <td class="m-help">set the object properties&nbsp;</td>
         </tr>
         <tr class="summary-item">
            <td class="attributes">
               &nbsp;
               
            </td>
            <td class="name"><a href="./prtRegressRvm/train.html">train</a></td>
            <td class="m-help">Train a prtAction object using training a prtDataSet object.&nbsp;</td>
         </tr>
      </table>
   </body>
</html>